/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hedwig.server.delivery;

/**
 * Throttling Policy in Delivery Process
 */
public interface ThrottlingPolicy {

    /**
     * Tell throttling policy that a message is consumed.
     *
     * @param newSeqIdConsumed
     *          seq id that the message is consumed.
     * @return true if this message is consumed, otherwise false.
     */
    public boolean messageConsumed(long newSeqIdConsumed);

    /**
     * Should throttle the deliver?
     *
     * @param lastSeqIdDelivered
     *          last seq id delivered.
     * @return true if we should throttle the delivery, otherwise false.
     */
    public boolean shouldThrottle(long lastSeqIdDelivered);
}
